HttpClientImpl

class HttpClientImpl : BaseHttpClient<HttpResponse>

A HTTP client, based on @actions/http-client.

Constructors

HttpClientImpl
Link copied to clipboard
fun HttpClientImpl(builder: HttpClientBuilder.() -> Unit = {})

Functions

close
Link copied to clipboard
open override fun close()
del
Link copied to clipboard
open suspend fun del(url: String, headers: HeaderProvider = HeaderProvider { }): HttpResponse
get
Link copied to clipboard
open suspend fun get(url: String, headers: HeaderProvider = HeaderProvider { }): HttpResponse
getExternalTypedJson
Link copied to clipboard
suspend fun <T> getExternalTypedJson(url: String, additionalHeaders: Map<String, String> = emptyMap()): JSTypedHttpResponse<T>
GET a JSON response, casting it to the requested type in JS.
head
Link copied to clipboard
open suspend fun head(url: String, headers: HeaderProvider = HeaderProvider { }): HttpResponse
options
Link copied to clipboard
open suspend fun options(url: String, headers: HeaderProvider = HeaderProvider { }): HttpResponse
patch
Link copied to clipboard
open suspend fun patch(url: String, data: <ERROR CLASS><<ERROR CLASS>>, headers: HeaderProvider = HeaderProvider { }): HttpResponse
open suspend fun patch(url: String, data: <ERROR CLASS><String>, headers: HeaderProvider = HeaderProvider { }): HttpResponse
open suspend fun patch(url: String, data: <ERROR CLASS>, headers: HeaderProvider = HeaderProvider { }): HttpResponse
open suspend fun patch(url: String, data: String, headers: HeaderProvider = HeaderProvider { }): HttpResponse
patchExternalTypedJson
Link copied to clipboard
suspend fun <T> patchExternalTypedJson(url: String, data: Any, additionalHeaders: Map<String, String> = emptyMap()): JSTypedHttpResponse<T>
PATCH JSON stringified data and get a JSON response, casting it to the requested type in JS.
post
Link copied to clipboard
open suspend fun post(url: String, data: <ERROR CLASS><<ERROR CLASS>>, headers: HeaderProvider = HeaderProvider { }): HttpResponse
open suspend fun post(url: String, data: <ERROR CLASS><String>, headers: HeaderProvider = HeaderProvider { }): HttpResponse
open suspend fun post(url: String, data: <ERROR CLASS>, headers: HeaderProvider = HeaderProvider { }): HttpResponse
open suspend fun post(url: String, data: String, headers: HeaderProvider = HeaderProvider { }): HttpResponse
postExternalTypedJson
Link copied to clipboard
suspend fun <T> postExternalTypedJson(url: String, data: Any, additionalHeaders: Map<String, String> = emptyMap()): JSTypedHttpResponse<T>
POST JSON stringified data and get a JSON response, casting it to the requested type in JS.
put
Link copied to clipboard
open suspend fun put(url: String, data: <ERROR CLASS><<ERROR CLASS>>, headers: HeaderProvider = HeaderProvider { }): HttpResponse
open suspend fun put(url: String, data: <ERROR CLASS><String>, headers: HeaderProvider = HeaderProvider { }): HttpResponse
open suspend fun put(url: String, data: <ERROR CLASS>, headers: HeaderProvider = HeaderProvider { }): HttpResponse
open suspend fun put(url: String, data: String, headers: HeaderProvider = HeaderProvider { }): HttpResponse
putExternalTypedJson
Link copied to clipboard
suspend fun <T> putExternalTypedJson(url: String, data: Any, additionalHeaders: Map<String, String> = emptyMap()): JSTypedHttpResponse<T>
PUT JSON stringified data and get a JSON response, casting it to the requested type in JS.
request
Link copied to clipboard
open suspend override fun request(verb: String, url: String, data: <ERROR CLASS>, headers: HeaderProvider): HttpResponse
open suspend override fun request(verb: String, url: String, data: String, headers: HeaderProvider): HttpResponse

Sources

js source
Link copied to clipboard